GET   https://api.d-tools.com/SI/Subscribe/ServiceOrders?clients[0]={clients[0]}&clients[1]={clients[1]}&progresses[0]={progresses[0]}&progresses[1]={progresses[1]}&includeImported={includeImported}&searchText={searchText}&includeDeleted={includeDeleted}&pageNumber={pageNumber}&pageSize={pageSize}

Get service order published by a SI user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clients

Clients to filter service orders (Optional)

Collection of string

None.

progresses

Progresses to filter servic orders (Optional)

Collection of string

None.

includeImported

Boolean. Include already imported service orders. Optional with default value false which means by default you will only see service orders which are not imported.

boolean

Default value is False

searchText

The search text.

string

None.

includeDeleted

Boolean. Include service order deleted in SI. Optional with default value false which means by default you will only see active service orders which are not deleted.

boolean

Default value is False

pageNumber

The page number.

integer

Default value is 1

pageSize

The page size.

integer

Default value is 50

Body Parameters

None.

Response Information

Resource Description

ServiceOrdersResult
NameDescriptionTypeAdditional information
ServiceOrders

Service orders

Collection of ServiceOrderInfo

None.

TotalCount

Total count of service orders

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "ServiceOrders": [
    {
      "Id": "sample string 1",
      "Client": "sample string 2",
      "Number": "sample string 3",
      "Name": "sample string 4",
      "Progress": "sample string 5",
      "Description": "sample string 6",
      "ImportedOn": "2024-04-29T13:54:08.0155885+00:00",
      "PublishedOn": "2024-04-29T13:54:08.0155885+00:00",
      "Deleted": true
    },
    {
      "Id": "sample string 1",
      "Client": "sample string 2",
      "Number": "sample string 3",
      "Name": "sample string 4",
      "Progress": "sample string 5",
      "Description": "sample string 6",
      "ImportedOn": "2024-04-29T13:54:08.0155885+00:00",
      "PublishedOn": "2024-04-29T13:54:08.0155885+00:00",
      "Deleted": true
    }
  ],
  "TotalCount": 1
}

application/xml, text/xml

Sample:
<ServiceOrdersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTools.SICloudAPI.DataObjects">
  <ServiceOrders>
    <ServiceOrderInfo>
      <Client>sample string 2</Client>
      <Deleted>true</Deleted>
      <Description>sample string 6</Description>
      <Id>sample string 1</Id>
      <ImportedOn>2024-04-29T13:54:08.0155885+00:00</ImportedOn>
      <Name>sample string 4</Name>
      <Number>sample string 3</Number>
      <Progress>sample string 5</Progress>
      <PublishedOn>2024-04-29T13:54:08.0155885+00:00</PublishedOn>
    </ServiceOrderInfo>
    <ServiceOrderInfo>
      <Client>sample string 2</Client>
      <Deleted>true</Deleted>
      <Description>sample string 6</Description>
      <Id>sample string 1</Id>
      <ImportedOn>2024-04-29T13:54:08.0155885+00:00</ImportedOn>
      <Name>sample string 4</Name>
      <Number>sample string 3</Number>
      <Progress>sample string 5</Progress>
      <PublishedOn>2024-04-29T13:54:08.0155885+00:00</PublishedOn>
    </ServiceOrderInfo>
  </ServiceOrders>
  <TotalCount>1</TotalCount>
</ServiceOrdersResult>